Set a Tag to a content item

{ addTagToItem }

Sets a Tag to the specified content item.

Method

/API3/content/addTagToItem

  • API Section: /API3/content
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
  • Input Parameters

    Name

    tagUsageApiData

    Object Type

    Description

    The tag usage object used to set a tag for a given content item.

    Output Response

    Successful Result Code

    200

    Response Type

    Description of Response Type

    Generic API response object with success or failure flag and related messages.

    Notes

    The tag needs to be added to the system first using 'addTag'. Use this method to apply to a content item.

    Examples

    Code Snippets

    Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

    TypeScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
    -H "paToken: [[apiKey]]" \
     -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
     -H "Content-Type: application/json" \
     "http://Your.Server.URL/API3/content/addTagToItem" \
     -d '{
      "itemId" : "itemId",
      "tagId" : "tagId"
    }'
    
    import com.pyramidanalytics.*;
    import com.pyramidanalytics.auth.*;
    import com.pyramidanalytics.model.*;
    import com.pyramidanalytics.api.ContentServiceApi;
    
    import java.util.*;
    import java.time.*;
    
    public class ContentServiceApiExample {
        public static void main(String[] args) {
            ApiClient defaultClient = Configuration.getDefaultApiClient();
            defaultClient.setBasePath("http://Your.Server.URL/");
            
            // Configure API key authorization: paToken
            ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
            paToken.setApiKey("YOUR API KEY");
            // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
            //paToken.setApiKeyPrefix("Token");
    
            // Create an instance of the API class
            ContentServiceApi apiInstance = new ContentServiceApi();
            // Initialize the tagUsageApiData parameter object for the call
            TagUsageApiData tagUsageApiData = ; // Create the input object for the operation, type: TagUsageApiData 
    
            try {
                ModifiedItemsResult result = apiInstance.addTagToItem(tagUsageApiData);
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling ContentServiceApi#addTagToItem");
                e.printStackTrace();
            }
        }
    }
    
    import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
    
    // Create an instance of the API class
    const api = new PyramidAnalyticsWebApi.ContentServiceApi("http://Your.Server.URL")
    
    // Configure API key authorization: paToken
    api.setApiToken("YOUR API KEY");
    
    const tagUsageApiData = ; // {TagUsageApiData} 
    
    api.addTagToItem(tagUsageApiData).then(function(data) {
      console.log('API called successfully. Returned data: ' + data);
    }, function(error) {
      console.error(error);
    });
    
    
    using System;
    using System.Diagnostics;
    using PyramidAnalytics.Sdk.Api;
    using PyramidAnalytics.Sdk.Client;
    using PyramidAnalytics.Sdk.Model;
    
    public class addTagToItemExample
    {
        public static void Main()
        {
            Configuration conf = new Configuration();
            conf.BasePath = "http://Your.Server.URL/";
            
            
            // Configure API key authorization: paToken
            conf.ApiKey.Add("paToken", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // conf.ApiKeyPrefix.Add("paToken", "Bearer");
    
            GlobalConfiguration.Instance = conf;
            
            // Create an instance of the API class
            var apiInstance = new ContentServiceApi();
            // Initialize the tagUsageApiData parameter object for the call
            var tagUsageApiData = new TagUsageApiData(); // TagUsageApiData | 
    
            try {
                // Sets a Tag to the specified content item.
                ModifiedItemsResult result = apiInstance.addTagToItem(tagUsageApiData);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentServiceApi.addTagToItem: " + e.Message );
            }
        }
    }
    
    
    import com.pyramidanalytics
    from com.pyramidanalytics import ApiException
    from com.pyramidanalytics import ContentServiceApi
    from pprint import pprint
    
            
    # Configure API key authorization: paToken
    api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
    
    with com.pyramidanalytics.ApiClient(api_config) as api_client:
        # Create an instance of the API class
        api_instance = ContentServiceApi(api_client)
        # Initialize the tagUsageApiData parameter object for the call
        tagUsageApiData =  # TagUsageApiData | 
    
        try:
            # Sets a Tag to the specified content item.
            api_response = api_instance.add_tag_to_item(tagUsageApiData)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling ContentServiceApi->addTagToItem: %s\n" % e)
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
    
    // Configure API key authorization: paToken
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
    
    // Create an instance of the API class
    $api_instance = new OpenAPITools\Client\Api\ContentServiceApi();
    $tagUsageApiData = ; // TagUsageApiData | 
    
    try {
        $result = $api_instance->addTagToItem($tagUsageApiData);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling ContentServiceApi->addTagToItem: ', $e->getMessage(), PHP_EOL;
    }
    ?>